home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / iiv.z / iiv
Encoding:
Text File  |  2001-04-17  |  11.5 KB  |  265 lines
  1.  
  2.  
  3.  
  4. IIIINNNNSSSSIIIIGGGGHHHHTTTT((((1111))))                                                          IIIINNNNSSSSIIIIGGGGHHHHTTTT((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      insight, iiv - The IRIS InSight Online Documentation (Book) Viewer
  10.  
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      insight [ -v bbbbooooooookkkk____nnnnaaaammmmeeee [ -print ] [ -r ] [ -attrib aaaattttttttrrrr ] [ -h ssssttttyyyylllleeee ] ]
  14.              [ -l lllliiiibbbb____ppppaaaatttthhhh ] [ -b bbbbooooooookkkksssshhhheeeellllffff____nnnnaaaammmmeeee [ -only ] ]
  15.              [ -auth aaaauuuutttthhhhoooorrrriiiizzzzaaaattttiiiioooonnnn____ssssttttrrrriiiinnnngggg ]
  16.              [ -f | -nofork ]
  17.  
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      The _I_R_I_S _I_n_S_i_g_h_t _V_i_e_w_e_r is an online information retrieval system. This
  21.      viewer provides an easy-to-use interface which allows the user to search
  22.      and browse through online information that is distributed from _S_i_l_i_c_o_n
  23.      _G_r_a_p_h_i_c_s.
  24.  
  25. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  26.      Command line options are described below.
  27.  
  28.      -v   The -v bbbbooooooookkkk____nnnnaaaammmmeeee option tells _i_n_s_i_g_h_t to invoke only the Viewer
  29.           window, and to load the specified book.  The bbbbooooooookkkk____nnnnaaaammmmeeee is the
  30.           abbreviated short title for the book.  This title can be found on
  31.           the stow icon for the book, or from the candidate list of the
  32.           library window during a search. Note that this option is case-
  33.           sensitive. For example,
  34.  
  35.           iiiinnnnssssiiiigggghhhhtttt ----vvvv IIIIRRRRIIIISSSSEEEEsssssssseeeennnnttttiiiiaaaallllssss
  36.  
  37.      -b   The -b bbbbooooooookkkksssshhhheeeellllffff____nnnnaaaammmmeeee option tells _i_n_s_i_g_h_t to invoke the Library
  38.           (main) window and to produce a list of available books from the
  39.           specified bookshelf. By default, the entire Library is loaded
  40.           (unless ----oooonnnnllllyyyy is specified along with this option), and _i_n_s_i_g_h_t
  41.           simply changes it's default Library view to open that specific
  42.           bookshelf.
  43.  
  44.           A bookshelf is defined as a directory containing a set of books.  By
  45.           default, bookshelves are located in
  46.           /_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_l_i_b_r_a_r_y/_S_G_I__b_o_o_k_s_h_e_l_v_e_s.
  47.  
  48.           To examine a sample bookshelf, look under the default path of
  49.           /usr/share/Insight/library/SGI_bookshelves. All the directories
  50.           contained under this area are defined as "bookshelves". They are
  51.           displayed in the viewer as a vertically-stacked shelf, containing a
  52.           set of books. By convention, below each of those directories exists
  53.           another directory, called "books".
  54.  
  55.           The path to the bookshelf should be specified (this can be a
  56.           relative pathname), along with the bookshelf name.  For example,
  57.  
  58.           iiiinnnnssssiiiigggghhhhtttt ----bbbb
  59.                  ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbbrrrraaaarrrryyyy////SSSSGGGGIIII____bbbbooooooookkkksssshhhheeeellllvvvveeeessss////SSSSGGGGIIII____AAAAddddmmmmiiiinnnn
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. IIIINNNNSSSSIIIIGGGGHHHHTTTT((((1111))))                                                          IIIINNNNSSSSIIIIGGGGHHHHTTTT((((1111))))
  71.  
  72.  
  73.  
  74.           will display the contents for the SGI_Admin bookshelf in the library
  75.           viewer.
  76.  
  77.  
  78.      -only
  79.           Used in conjunction with -b bbbbooooooookkkksssshhhheeeellllffff____nnnnaaaammmmeeee, this forces _i_n_s_i_g_h_t to
  80.           only load the specified bookshelf and not the entire Library.
  81.  
  82.      -l   The -l lllliiiibbbb____ppppaaaatttthhhh option tells _i_n_s_i_g_h_t to invoke the Library (main)
  83.           window, and to load the specified library.  A library is defined as
  84.           a collection of bookshelves. By default, the library is rooted at
  85.           /_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_l_i_b_r_a_r_y.  The path (relative or full) to the new
  86.           library should be specified. Only one library may be specified. For
  87.           example,
  88.  
  89.           iiiinnnnssssiiiigggghhhhtttt ----llll ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbb____XXXXXXXXXXXX
  90.  
  91.      -r   The -r option is used in conjunction with the -v bbbbooooooookkkk____nnnnaaaammmmeeee option.
  92.           It instructs the _i_n_s_i_g_h_t software to load the specified book in a
  93.           "restricted" viewer.  A restricted viewer is defined as one that
  94.           does not have a Table-of-Contents navigation area.
  95.  
  96.      -attrib
  97.           The -attrib aaaattttttttrrrr option is used in conjunction with the -v bbbbooooooookkkk____nnnnaaaammmmeeee
  98.           option. It instructs the _i_n_s_i_g_h_t software to load the specified
  99.           book, and scroll to a particular entry point.  That entry point is
  100.           designated by the result which is generated from the attribute
  101.           string. Note that the aaaattttttttrrrr string must be enclosed in double-quotes
  102.           in order to be properly interpreted.
  103.  
  104.           For any invalid expressions, or those that cannot be resolved,
  105.           _i_n_s_i_g_h_t will simply invoke the book in the Viewer, and will not
  106.           scroll to any particular entry point.
  107.  
  108.           Although rarely used by an end-user, the following attribute
  109.           commands are available :
  110.  
  111.           _q_u_e_r_y(_e_x_p_r_e_s_s_i_o_n)
  112.  
  113.           takes any expression valid in the _i_n_s_i_g_h_t query language, and
  114.           returns the entry point of the first element in the specified book
  115.           that matches the expression. For more information on the query
  116.           language, please consult the IIIIRRRRIIIISSSS IIIInnnnSSSSiiiigggghhhhtttt oooonnnn----lllliiiinnnneeee hhhheeeellllpppp.
  117.  
  118.           For example, a user could specify the following:
  119.  
  120.           iiiinnnnssssiiiigggghhhhtttt ----vvvv PPPPeeeerrrrSSSSyyyyssssAAAAddddmmmmiiiinnnn ----aaaattttttttrrrriiiibbbb """"qqqquuuueeeerrrryyyy((((mmmmaaaannnnaaaaggggiiiinnnngggg pppprrrriiiinnnntttteeeerrrrssss))))"""".
  121.  
  122.           The result would bring up the Personal System Administration Guide
  123.           and take them to the first area in the book that contained the
  124.           phrase "managing printers".
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. IIIINNNNSSSSIIIIGGGGHHHHTTTT((((1111))))                                                          IIIINNNNSSSSIIIIGGGGHHHHTTTT((((1111))))
  137.  
  138.  
  139.  
  140.           _i_d_m_a_t_c_h(_n_a_m_e, _v_a_l_u_e)
  141.  
  142.           is a special case of query(), which searches in the current book for
  143.           the first element which has an attribute with the specified 'name'
  144.           and 'value' and returns the entry point for that element. If the
  145.           'name' argument is omitted (i.e., if there is only one argument, or
  146.           the first of two arguments is empty), then only attributes named ID
  147.           will be considered.  This function is used to implement the most
  148.           common kind of hypertext link in SGML (Standard Generalized Markup
  149.           Language).
  150.  
  151.           For example:
  152.  
  153.           iiiinnnnssssiiiigggghhhhtttt ----vvvv PPPPeeeerrrrSSSSyyyyssssAAAAddddmmmmiiiinnnn ----aaaattttttttrrrriiiibbbb """"iiiiddddmmmmaaaattttcccchhhh((((111188880000))))"""".
  154.  
  155.           _a_n_c_e_s_t_o_r(_e_x_p_r_e_s_s_i_o_n)
  156.  
  157.           returns returns the immediate parent element (entry point) for the
  158.           enclosed expression.
  159.  
  160.           _l_s_i_b_l_i_n_g(_e_x_p_r_e_s_s_i_o_n)
  161.  
  162.           returns the preceding sibling element (entry point) for the enclosed
  163.           expression.
  164.  
  165.           _r_s_i_b_l_i_n_g(_e_x_p_r_e_s_s_i_o_n)
  166.  
  167.           similar to _l_s_i_b_l_i_n_g(_e_x_p_r_e_s_s_i_o_n), but returns the next sibling
  168.           element (entry point) for the enclosed expression.
  169.  
  170.      -h   The -h ssssttttyyyylllleeee option is used in conjunction with the -v bbbbooooooookkkk____nnnnaaaammmmeeee
  171.           option. It instructs the _i_n_s_i_g_h_t software to load the specified
  172.           book, using the specified stylesheet.  Although rarely used by an
  173.           end-user, it is available.
  174.  
  175.      -print
  176.           The -print option is used to open the print window automatically for
  177.           the book specified by the -v bbbbooooooookkkk____nnnnaaaammmmeeee option.
  178.  
  179.      -auth
  180.           The -auth aaaauuuutttthhhhoooorrrriiiizzzzaaaattttiiiioooonnnn____ssssttttrrrriiiinnnngggg option instructs _i_n_s_i_g_h_t to use the
  181.           designated string as an authorization key for reading books that
  182.           have been licensed. At this time, this option will not be needed for
  183.           accessing the online books from _S_i_l_i_c_o_n _G_r_a_p_h_i_c_s.
  184.  
  185.      -f   The -f (or -nofork) option tells _i_n_s_i_g_h_t to run in the foreground,
  186.           and to disable "run-once" behavior.  "Run-once" is when oooonnnneeee copy of
  187.           IRIS InSight can be invoked, per X-display. By default, "run-once"
  188.           behavior is turned on.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. IIIINNNNSSSSIIIIGGGGHHHHTTTT((((1111))))                                                          IIIINNNNSSSSIIIIGGGGHHHHTTTT((((1111))))
  203.  
  204.  
  205.  
  206.      For additional information, please consult the IIIIRRRRIIIISSSS IIIInnnnSSSSiiiigggghhhhtttt oooonnnn----lllliiiinnnneeee hhhheeeellllpppp.
  207.  
  208.  
  209. FFFFIIIILLLLEEEESSSS
  210.      /usr/sbin/insight, /usr/sbin/iiv
  211.  
  212. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  213.      _s_g_i_h_e_l_p(_1)
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.                                                                         PPPPaaaaggggeeee 4444
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.